-
Notifications
You must be signed in to change notification settings - Fork 38.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enable shell completion descriptions for bash #113636
Conversation
Cobra provides support for completion descriptions for bash. It was turned off because of a bug with certain bash menu options which have been fixed by Cobra 1.3.0. Signed-off-by: Marc Khouzam <marc.khouzam@gmail.com>
/sig cli |
/triage accepted I pulled down this branch and confirmed that the descriptions now work exactly as described. Thank you for the detailed PR description! 👌 |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: KnVerey, marckhouzam The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Thanks for the quick merge @KnVerey ! |
What type of PR is this?
/kind feature
What this PR does / why we need it:
This PR enables descriptions for
kubectl
shell completion for the bash shell, just like is already supported forzsh
,fish
andpowershell
.This support is transparently provided by Cobra. It was turned off for
kubetl
because of a bug with certain bash menu options which has been fixed by Cobra 1.3.0 which has been used bykubectl
for a while now.Before the PR:
With the PR:
Special notes for your reviewer:
Helm has been using this feature without issue since Helm 3.7.0 which has been released September 15, 2021.
However, in a possibly overly cautious approach, helm allows users to choose to disable completion descriptions for bash and all other shells as well. As for
kubectl
, it currently enables shell descriptions all the time forzsh
,powershell
andfish
, so this PR does the same forbash
.Does this PR introduce a user-facing change?
cc @brianpursley